/*
 *  Copyright (C) 2010 Fabien Renaud
 * 
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 * 
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 * 
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.boc.botv.service;

import com.boc.botv.model.PaymentMethod;
import java.util.List;

/**
 * Gestionnaire des méthodes de paiements
 * @author Fabien Renaud
 */
public interface PaymentMethodManager {

  /**
   * Renvoie la liste des méthodes de paiements
   * @return
   */
  public List<PaymentMethod> getPaymentMethods();

  /**
   * Créé une méthode de paiement 
   * @param paymentMethod la payment méthode initialisée par le formulaire
   * @return true si la méthode de paiement a été correctement crée 
   */
  public void createPaymentMethod(PaymentMethod paymentMethod);

  /**
   * Désactive la méthode de paiement
   * @param paymentId l'id de la méthode de paiement
   * @return true la méthode de paiement est désactivée
   */
  public boolean disablePaymentMethod(int paymentId);

  /**
   * Vérifie si la carte est active et non expiré
   * @param paymentMethod la méthode de paiement de l'utilisateur 
   * @return true si la méthode est valide
   */
  public boolean isValid(PaymentMethod paymentMethod);

  /**
   * Indique que la phase de vérification de la méthode de paiement a commencé.
   * @param paymentId l'id de la méthode de paiement
   * @return true la méthode de paiement est en phase de vérification
   */
  public boolean checkPaymentMethod(int paymentId);

  /**
   * active la méthode de paiement
   * @param paymentId l'id de la méthode de paiement
   * @return true la méthode de paiement est activée
   */
  public boolean enablePaymentMethod(int paymentId);

  /**
   * Obtient la méthode de paiement
   * @param paymentId l'id de la méthode de paiment
   * @return la méthode de paiement
   */
  public PaymentMethod getPaymentMethod(int paymentId);

  /**
   * Met à jour une méthode de paiement.
   * @param pm la méthode de paiement
   * @return true si la méthode de paiement a été mise à jour.
   */
  public boolean updatePaymentMethod(PaymentMethod pm);

  /**
   * Refuse la méthode de paiement.
   * @param paymentId l'id de la méthode de paiement
   * @return true si la méthode est refusée
   */
  public boolean refusePaymentMethod(int pmId);

  /**
   * Met à jour le statut de la méthode de paiement
   * @param pmId Id de la méthode de paiement à mettre à jour
   * @return -1 en cas d'échec, sinon la valeur du nouveau statut
   */
  public int nextStepPaymentMethod(int pmId);
}
